Embabel Agent Documentation/com.embabel.ux.form

Package-level declarations

Types

data class Button(val label: String, val description: String = label, val id: String = UUID.randomUUID().toString()) : Control

Checkbox

data class Checkbox(val label: String, val checked: Boolean = false, val required: Boolean = true, val disabled: Boolean = false, val id: String = UUID.randomUUID().toString()) : RequirableControl

Control

sealed interface Control

ControlType

enum ControlType : Enum<ControlType>

ControlValue

sealed class ControlValue

DatePicker

data class DatePicker(val label: String, val value: String? = null, val minDate: String? = null, val maxDate: String? = null, val required: Boolean = true, val disabled: Boolean = false, val id: String = UUID.randomUUID().toString()) : RequirableControl

DefaultFormProcessor

class DefaultFormProcessor : FormProcessor

DoubleRangeValidator

class DoubleRangeValidator(min: Double, max: Double, errorMessage: String) : Validator

Dropdown

data class Dropdown(val label: String, val options: List<DropdownOption>, val placeholder: String = "", val required: Boolean = true, val disabled: Boolean = false, val id: String = UUID.randomUUID().toString()) : RequirableControl

DropdownOption

data class DropdownOption(val label: String, val value: String = label)

DropDownValidator

class DropDownValidator(options: List<String>, errorMessage: String) : Validator

FileUpload

data class FileUpload(val label: String, val acceptedFileTypes: List<String> = listOf("*/*"), val maxFileSize: Long? = null, val maxFiles: Int = 1, val required: Boolean = true, val disabled: Boolean = false, val id: String = UUID.randomUUID().toString()) : RequirableControl

Form

data class Form(val title: String, val controls: List<Control>, val id: String = UUID.randomUUID().toString())

UX-independent form definition. Controls, not data.

FormBinder

class FormBinder<T : Any>(targetClass: KClass<T>)

Form binder system that maps form submission values to Kotlin data classes and Java classes

FormField

@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.FIELD])

annotation class FormField(val controlId: String)

Indicates that this is a form field. Only necessary for renaming and other customization. IMPORTANT: In Kotlin this annotation must be on the property, as in @property:FormField("controlId") myProperty: String

FormGenerator

interface FormGenerator

Generate forms from JVM types.

FormProcessor

interface FormProcessor

Forms

object Forms

FormSubmission

data class FormSubmission(val formId: String, val values: Map<String, Any>, val submissionId: String = UUID.randomUUID().toString(), val timestamp: Instant = Instant.now())

Raw data from the user

FormSubmissionResult

data class FormSubmissionResult(val submission: FormSubmission, val values: Map<String, ControlValue>, val valid: Boolean = true, val validationErrors: Map<String, String> = emptyMap())

NoFormField

@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.FIELD])

annotation class NoFormField

Indicates that this is not a form field

PatternValidator

class PatternValidator(pattern: String, errorMessage: String) : Validator

RadioGroup

data class RadioGroup(val label: String, val options: List<RadioOption>, val selectedValue: String? = null, val required: Boolean = true, val disabled: Boolean = false, val id: String = UUID.randomUUID().toString()) : RequirableControl

RadioOption

data class RadioOption(val label: String, val value: String = label)

RequirableControl

sealed interface RequirableControl : Control

RequiredValidator

class RequiredValidator : Validator

SimpleFormGenerator

object SimpleFormGenerator : FormGenerator

Simple form generator that uses FormField annotations

Slider

data class Slider(val label: String, val min: Double = 0.0, val max: Double = 100.0, val step: Double = 1.0, val value: Double = min, val showMarkers: Boolean = false, val required: Boolean = true, val disabled: Boolean = false, val id: String = UUID.randomUUID().toString()) : RequirableControl

Text

@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.FIELD])

annotation class Text(val label: String, val placeholder: String = "")

Annotation for a text field

TextArea

data class TextArea(val label: String, val placeholder: String = "", val value: String = "", val rows: Int = 3, val maxLength: Int? = null, val required: Boolean = true, val disabled: Boolean = false, val id: String = UUID.randomUUID().toString()) : RequirableControl

TextField

data class TextField(val label: String, val placeholder: String = "", val value: String = "", val maxLength: Int? = null, val required: Boolean = true, val disabled: Boolean = false, val validationPattern: String? = null, val validationMessage: String? = null, val id: String = UUID.randomUUID().toString()) : RequirableControl

TimePicker

data class TimePicker(val label: String, val value: String? = null, val is24Hour: Boolean = false, val required: Boolean = true, val disabled: Boolean = false, val id: String = UUID.randomUUID().toString()) : RequirableControl

Toggle

data class Toggle(val label: String, val enabled: Boolean = false, val disabled: Boolean = false, val id: String = UUID.randomUUID().toString()) : Control

ValidationResult

data class ValidationResult(val isValid: Boolean, val errorMessage: String? = null)

Validator

fun interface Validator

Functions

bindTo

inline fun <T : Any> FormSubmissionResult.bindTo(): T

Extension function to make binding more convenient

fun <T : Any> FormSubmissionResult.bindTo(javaClass: Class<T>): T

Extension function for Java class binding

generateForm

inline fun <T : Any> FormGenerator.generateForm(title: String): Form

Generate a form from any class with FormField annotations

getPropertiesInDeclarationOrder

fun <T : Any> getPropertiesInDeclarationOrder(kClass: KClass<T>): List<KProperty<*>>